package com.beardedhen.harmonybootstrap.api.view;

/**
 * Views which implement this interface visually display ongoing progress to users
 */
public interface ProgressView {

    /**
     * Updates the amount of progress displayed to the user.
     *
     * @param progress a positive integer
     */
    void setProgress(int progress);

    /**
     * Gets progress.
     *
     * @return the amount of progress displayed to the user
     */
    int getProgress();

    /**
     * Used for settings the maxprogress. Also check if Cumulative progress is smaller than the
     * max before asigning.
     *
     * @param maxProgress the maxProgress value
     */
    void setMaxProgress(int maxProgress);
}
